Skip to content

Attempt a write-up about t-shaped-signals. #2232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 17 commits into from
Jul 15, 2025

Conversation

jsuereth
Copy link
Contributor

@jsuereth jsuereth commented May 5, 2025

Adds non-normative guide on T-Shaped design for signals.

Changes

  • Define the t-shaped concept as I use it a lot when describing Semantic Conventions processes.
  • Outline some examples the two parts in existing semconv.

Merge requirement checklist

Copy link
Contributor

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Should we provide some guidance on when to use which?

E.g. when designing conventions that apply to different systems or implementations, define generic conventions for broadly applicable signals and consider having system-specific rich conventions.

Also, wonder if we can link to it from other docs.
Maybe we should have docs/non-normative/how-to-write-conventions and put it there along with other meta-guidance and a README?

@jsuereth jsuereth marked this pull request as ready for review July 1, 2025 13:04
@jsuereth jsuereth requested review from a team as code owners July 1, 2025 13:04
@github-actions github-actions bot added enhancement New feature or request area:other labels Jul 1, 2025
@jsuereth
Copy link
Contributor Author

jsuereth commented Jul 1, 2025

@lmolkova

Should we provide some guidance on when to use which?

Yes, added.

Also, wonder if we can link to it from other docs.
Maybe we should have docs/non-normative/how-to-write-conventions and put it there along with other meta-guidance and a README?

Updating now, this should be ready for review.

Copy link
Contributor

@lmolkova lmolkova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excited to see it written down!

@lmolkova lmolkova moved this from Untriaged to Needs More Approval in Semantic Conventions Triage Jul 9, 2025
Copy link
Contributor

@kamphaus kamphaus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lmolkova lmolkova moved this from Needs More Approval to Ready to be Merged in Semantic Conventions Triage Jul 15, 2025
@jsuereth jsuereth enabled auto-merge July 15, 2025 14:15
@jsuereth jsuereth added this pull request to the merge queue Jul 15, 2025
Merged via the queue into open-telemetry:main with commit 4ad1574 Jul 15, 2025
15 checks passed
@jsuereth jsuereth deleted the wip-t-shaped-signals branch July 15, 2025 14:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:other enhancement New feature or request
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants